\hypertarget{class_user}{\section{User Class Reference}
\label{class_user}\index{User@{User}}
}
Inheritance diagram for User\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_user}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_user_aa67031b663e39314207197d3b5dfd735}{User} ()
\item 
\hyperlink{class_user_a30dd7fff4fec7a39f9be9d27d4b22a59}{get\-I\-D} ()
\item 
\hyperlink{class_user_ad870c94a5775868891f6c50b9818d627}{login} (\$username, \$password)
\item 
\hyperlink{class_user_ad488b2fc379939d02890e0dc0533d1a4}{logged\-\_\-in} ()
\item 
\hyperlink{class_user_a1799d391532ee71dea5f41d66e398039}{register} (\$username, \$password, \$mail, \$status, \$userdata)
\item 
\hyperlink{class_user_a03ec20b184d0b4da2b864d432d22323c}{check\-If\-Username\-Exist} (\$username)
\item 
\hyperlink{class_user_a082405d89acd6835c3a7c7a08a7adbab}{logout} ()
\item 
\hyperlink{class_user_aff9a1fb07dca963c2c9a8ffe66b45ded}{remove} ()
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\hyperlink{class_user}{User} Controller \begin{DoxyAuthor}{Author}
Simon, Dennis, Denis 
\end{DoxyAuthor}


\subsection{Member Function Documentation}
\hypertarget{class_user_a03ec20b184d0b4da2b864d432d22323c}{\index{User@{User}!check\-If\-Username\-Exist@{check\-If\-Username\-Exist}}
\index{check\-If\-Username\-Exist@{check\-If\-Username\-Exist}!User@{User}}
\subsubsection[{check\-If\-Username\-Exist}]{\setlength{\rightskip}{0pt plus 5cm}{\bf check\-If\-Username\-Exist} (
\begin{DoxyParamCaption}
\item[{\$}]{username}
\end{DoxyParamCaption}
)}}\label{class_user_a03ec20b184d0b4da2b864d432d22323c}
method to check if a username already exists in the database returns true or false 
\begin{DoxyParams}[1]{Parameters}
string & {\em \$username} & \\
\hline
\end{DoxyParams}
\hypertarget{class_user_a30dd7fff4fec7a39f9be9d27d4b22a59}{\index{User@{User}!get\-I\-D@{get\-I\-D}}
\index{get\-I\-D@{get\-I\-D}!User@{User}}
\subsubsection[{get\-I\-D}]{\setlength{\rightskip}{0pt plus 5cm}{\bf get\-I\-D} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_user_a30dd7fff4fec7a39f9be9d27d4b22a59}
method to return the user id from current session \begin{DoxyReturn}{Returns}
int id 
\end{DoxyReturn}
\hypertarget{class_user_ad488b2fc379939d02890e0dc0533d1a4}{\index{User@{User}!logged\-\_\-in@{logged\-\_\-in}}
\index{logged\-\_\-in@{logged\-\_\-in}!User@{User}}
\subsubsection[{logged\-\_\-in}]{\setlength{\rightskip}{0pt plus 5cm}{\bf logged\-\_\-in} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_user_ad488b2fc379939d02890e0dc0533d1a4}
Logged in

public \begin{DoxyReturn}{Returns}
boolean if the user is logged in or not 
\end{DoxyReturn}
\hypertarget{class_user_ad870c94a5775868891f6c50b9818d627}{\index{User@{User}!login@{login}}
\index{login@{login}!User@{User}}
\subsubsection[{login}]{\setlength{\rightskip}{0pt plus 5cm}{\bf login} (
\begin{DoxyParamCaption}
\item[{\$}]{username, }
\item[{\$}]{password}
\end{DoxyParamCaption}
)}}\label{class_user_ad870c94a5775868891f6c50b9818d627}
Login \hyperlink{class_user}{User}

public 
\begin{DoxyParams}{Parameters}
{\em string} & the username \\
\hline
{\em string} & the password \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
boolean if the user was logged in or not 
\end{DoxyReturn}
\hypertarget{class_user_a082405d89acd6835c3a7c7a08a7adbab}{\index{User@{User}!logout@{logout}}
\index{logout@{logout}!User@{User}}
\subsubsection[{logout}]{\setlength{\rightskip}{0pt plus 5cm}{\bf logout} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_user_a082405d89acd6835c3a7c7a08a7adbab}
method to logout. clears the current session \hypertarget{class_user_a1799d391532ee71dea5f41d66e398039}{\index{User@{User}!register@{register}}
\index{register@{register}!User@{User}}
\subsubsection[{register}]{\setlength{\rightskip}{0pt plus 5cm}{\bf register} (
\begin{DoxyParamCaption}
\item[{\$}]{username, }
\item[{\$}]{password, }
\item[{\$}]{mail, }
\item[{\$}]{status, }
\item[{\$}]{userdata}
\end{DoxyParamCaption}
)}}\label{class_user_a1799d391532ee71dea5f41d66e398039}
method to register a new user. stores the new user in the D\-B 
\begin{DoxyParams}[1]{Parameters}
string & {\em \$username} & \\
\hline
string & {\em \$password} & \\
\hline
string & {\em \$mail} & \\
\hline
int & {\em \$status} & \\
\hline
object & {\em \$userdata} & \\
\hline
\end{DoxyParams}
\hypertarget{class_user_aff9a1fb07dca963c2c9a8ffe66b45ded}{\index{User@{User}!remove@{remove}}
\index{remove@{remove}!User@{User}}
\subsubsection[{remove}]{\setlength{\rightskip}{0pt plus 5cm}{\bf remove} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_user_aff9a1fb07dca963c2c9a8ffe66b45ded}
method to delete one user by the current user id \hypertarget{class_user_aa67031b663e39314207197d3b5dfd735}{\index{User@{User}!User@{User}}
\index{User@{User}!User@{User}}
\subsubsection[{User}]{\setlength{\rightskip}{0pt plus 5cm}{\bf User} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_user_aa67031b663e39314207197d3b5dfd735}


The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
/\-Applications/\-M\-A\-M\-P/htdocs/\-Workspace/blp2.\-0/application/controllers/\hyperlink{user_8php}{user.\-php}\end{DoxyCompactItemize}
